Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

guide: consolidate Exp Sharing intro #2711

Merged
merged 13 commits into from
Aug 18, 2021
Merged

Conversation

jorgeorpinel
Copy link
Contributor

@jorgeorpinel jorgeorpinel commented Aug 11, 2021

The idea behind this "consolidate" series of PRs (more to come) is to

a) summarize the explanations in this guide (without removing necessary info) and
b) to remove/bring details from the command reference (and link) per task #2 in #2548.


Follow up to #2618

Cascaded into #2654

@shcheklein shcheklein temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 11, 2021 16:15 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 13, 2021 20:19 Inactive
@jorgeorpinel jorgeorpinel changed the title guide: begin copy edits to Sharing Exps guide: summarizing **Sharing Experiments** Aug 13, 2021
@jorgeorpinel jorgeorpinel changed the title guide: summarizing **Sharing Experiments** guide: summarizing Sharing Experiments Aug 13, 2021
@jorgeorpinel jorgeorpinel changed the title guide: summarizing Sharing Experiments guide: consolidating Sharing Experiments Aug 13, 2021
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 13, 2021 21:26 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 15, 2021 18:12 Inactive
@jorgeorpinel jorgeorpinel marked this pull request as ready for review August 15, 2021 18:12
@jorgeorpinel jorgeorpinel requested a review from iesahin August 15, 2021 18:13
@jorgeorpinel jorgeorpinel changed the title guide: consolidating Sharing Experiments guide: consolidating Sharing Experiments (intro) Aug 15, 2021
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 15, 2021 18:19 Inactive
@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Aug 15, 2021

@iesahin the main changes to review here are in content/docs/user-guide/experiment-management/sharing-experiments.md

I thought we could do some small follow-up PRs like these to work on summarizing content. Feel free to contribute more changes or suggest alternatives beyond just reviewing. Thanks!

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 15, 2021 18:22 Inactive
@jorgeorpinel jorgeorpinel changed the title guide: consolidating Sharing Experiments (intro) guide: consolidate Exp Sharing intro Aug 15, 2021
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 15, 2021 18:48 Inactive
Copy link
Contributor

@iesahin iesahin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you Jorge.

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 17, 2021 19:55 Inactive
Copy link
Contributor

@daavoo daavoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should point out that dvc exp push/dvc exp pull only work with SSH:

using git over ssh with the correct SSH keys configured is the only supported method for authenticated git push in dvc exp push
(from https://iterativeai.slack.com/archives/CB41NAL8H/p1628743292077800?thread_ts=1628690244.073500&cid=CB41NAL8H)

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 18, 2021 08:15 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 18, 2021 08:18 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 18, 2021 08:19 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 18, 2021 08:27 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 18, 2021 08:28 Inactive
Comment on lines -36 to +31
storage https://remote.dvc.org/get-started-experiments
storage s3://mybucket/my-dvc-store
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

p.s. I also changed the DVC remote from HTTP. I don't think you can push to an HTTP remote. Cc @iesahin

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-guide-exps-shar-ofcxpu August 18, 2021 08:43 Inactive
@jorgeorpinel
Copy link
Contributor Author

Looks like restyled is just not picking up broken files recently... I had to run yarn format on these manually:

https://app.circleci.com/pipelines/github/iterative/dvc.org/10086/workflows/9b1bf89f-a432-49f2-9a20-72fe77dd4102/jobs/10145

@jorgeorpinel jorgeorpinel merged commit d1422b1 into guide/exps Aug 18, 2021
@casperdcl casperdcl deleted the guide/exps-sharing branch August 18, 2021 08:58
@jorgeorpinel jorgeorpinel self-assigned this Aug 18, 2021
jorgeorpinel added a commit that referenced this pull request Aug 20, 2021
* guide: summarize Sharing Exps intro

* ref: link from exp push/pull to Exp Sharing guide

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

* guide: rename Exp Sharing sections

* guide: summarize Exp Sharing examples

* guide: link from Exp Mgmt index to Sharing

* guide: ~~isolate~~ from link to Exp Sharing
per #2711 (review)

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

Co-authored-by: David de la Iglesia Castro <[email protected]>

* guide: mention only SSH Git URLs support exp sharing
per #2711 (review)

* guide: update dvc remote example in sharing exps

* yarn format some files
per https://app.circleci.com/pipelines/github/iterative/dvc.org/10086/workflows/9b1bf89f-a432-49f2-9a20-72fe77dd4102/jobs/10145

* prettier sharing-experiments.md

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

Co-authored-by: Casper da Costa-Luis <[email protected]>

Co-authored-by: David de la Iglesia Castro <[email protected]>
Co-authored-by: Casper da Costa-Luis <[email protected]>
@jorgeorpinel jorgeorpinel mentioned this pull request Oct 6, 2021
7 tasks
@jorgeorpinel jorgeorpinel restored the guide/exps-sharing branch October 8, 2021 19:38
@jorgeorpinel jorgeorpinel mentioned this pull request Oct 8, 2021
2 tasks
jorgeorpinel added a commit that referenced this pull request Dec 23, 2021
* guide: split Experiments (index) into sub-pages

* case: keep Persistent Exps in basic page

* cases: keep Run-cache in basic Exps page

* guide: edit Exp Mgmt index (intro)

* guide: edit basic Exps page inc. persisting them
and move run-cache to guide intro (index)

* guide: rename DVC Exps, remove Org Exps page

* guide: bash -> dvc in EM/Checkpoints

* guide: fix exps link

* guide: summarize Sharing Exps intro

* ref: link from exp push/pull to Exp Sharing guide

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

* guide: rename Exp Sharing sections

* guide: summarize Exp Sharing examples

* guide: link from Exp Mgmt index to Sharing

* guide: ~~isolate~~ from link to Exp Sharing
per #2711 (review)

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

Co-authored-by: David de la Iglesia Castro <[email protected]>

* guide: mention only SSH Git URLs support exp sharing
per #2711 (review)

* guide: update dvc remote example in sharing exps

* yarn format some files
per https://app.circleci.com/pipelines/github/iterative/dvc.org/10086/workflows/9b1bf89f-a432-49f2-9a20-72fe77dd4102/jobs/10145

* guide: consolidate Exp Sharing intro (#2711)

* guide: summarize Sharing Exps intro

* ref: link from exp push/pull to Exp Sharing guide

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

* guide: link from Exp Mgmt index to Sharing

* guide: ~~isolate~~ from link to Exp Sharing
per #2711 (review)

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

Co-authored-by: David de la Iglesia Castro <[email protected]>

* guide: mention only SSH Git URLs support exp sharing
per #2711 (review)

* guide: update dvc remote example in sharing exps

* yarn format some files
per https://app.circleci.com/pipelines/github/iterative/dvc.org/10086/workflows/9b1bf89f-a432-49f2-9a20-72fe77dd4102/jobs/10145

Co-authored-by: David de la Iglesia Castro <[email protected]>

* prettier sharing-experiments.md

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

Co-authored-by: Casper da Costa-Luis <[email protected]>

* guide: roll back wrong files

* guide: roll back Exp Mgmt index...

* guide: link to Sharing Exps from index

* guide: Listing exps on remotes
per #2908 (review)

* guide: don't mention Git here...
per #2908 (review)

* guide: clarify that git is needed for exps and sharing
per #2908 (review)

* guide: clarify note on Git requirement for DVC Exps
per #2908 (review)

* guide: simplify Sharing Exps intro (rel Git)
per #2908 (review)

* guide: rename exp list -r section

* copy edit

* cases: simplify note about requiring Git
per #2908 (review)

* guide: emoji for example in Sharing Exps
per #2908 (comment)

* guide: clarify note about Git-DVC repo required for Exps
per #2908 (review)

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

* guide: another example emoji en Sharing Exps

* Restyled by prettier (#2972)

Co-authored-by: Restyled.io <[email protected]>

* guide: list exps in Comparing guide, linked from Sharing
per #2908 (comment)

* guide: address feedback from
#2908 (review) and below

* guide: rephrase Git history exps org
per #2908 (review)

* guide:address Exp sharing feedback from
from #2908 (review) and below

* guide: update Git remote auth limitation wording
per #2908 (comment)

* guide: more copy edits on Exp Sharing and Comparing

* guide: clarify `exp list` remote info
per #2908 (review)

* guide: un0hide exp sharing details
per #2908 (review)

* guide: move multi-exp share example to how-to
per #2908 (review)

* guide: simplify Exp Sharing intro, add diagram
per should be focusing more on explaining (in simple terms, with diagrams) how it works

* guide: fix SSH URLS link in Exp Sharing...

* exp: roll back unrelated changes

* guide: Git -> Git remote
per #2908 (review)

* guide: improve Sharing exp intro
per #2908 (review)

* exp push/pull: remove --remote and --jobs details from guide and ref descs.
rel. #2908 (comment)

* guide: remove Sharing Exps example
per #2908 (comment)

* guide: simplify Sharing Exps intro
per #2908 (review)

* guide: add exp pull to diagram in Sharing Exps
per #2908 (comment)

Co-authored-by: David de la Iglesia Castro <[email protected]>
Co-authored-by: Casper da Costa-Luis <[email protected]>
Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
iesahin pushed a commit that referenced this pull request Apr 11, 2022
* guide: split Experiments (index) into sub-pages

* case: keep Persistent Exps in basic page

* cases: keep Run-cache in basic Exps page

* guide: edit Exp Mgmt index (intro)

* guide: edit basic Exps page inc. persisting them
and move run-cache to guide intro (index)

* guide: rename DVC Exps, remove Org Exps page

* guide: bash -> dvc in EM/Checkpoints

* guide: fix exps link

* guide: summarize Sharing Exps intro

* ref: link from exp push/pull to Exp Sharing guide

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

* guide: rename Exp Sharing sections

* guide: summarize Exp Sharing examples

* guide: link from Exp Mgmt index to Sharing

* guide: ~~isolate~~ from link to Exp Sharing
per #2711 (review)

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

Co-authored-by: David de la Iglesia Castro <[email protected]>

* guide: mention only SSH Git URLs support exp sharing
per #2711 (review)

* guide: update dvc remote example in sharing exps

* yarn format some files
per https://app.circleci.com/pipelines/github/iterative/dvc.org/10086/workflows/9b1bf89f-a432-49f2-9a20-72fe77dd4102/jobs/10145

* guide: consolidate Exp Sharing intro (#2711)

* guide: summarize Sharing Exps intro

* ref: link from exp push/pull to Exp Sharing guide

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

* guide: link from Exp Mgmt index to Sharing

* guide: ~~isolate~~ from link to Exp Sharing
per #2711 (review)

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

Co-authored-by: David de la Iglesia Castro <[email protected]>

* guide: mention only SSH Git URLs support exp sharing
per #2711 (review)

* guide: update dvc remote example in sharing exps

* yarn format some files
per https://app.circleci.com/pipelines/github/iterative/dvc.org/10086/workflows/9b1bf89f-a432-49f2-9a20-72fe77dd4102/jobs/10145

Co-authored-by: David de la Iglesia Castro <[email protected]>

* prettier sharing-experiments.md

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

Co-authored-by: Casper da Costa-Luis <[email protected]>

* guide: roll back wrong files

* guide: roll back Exp Mgmt index...

* guide: link to Sharing Exps from index

* guide: Listing exps on remotes
per #2908 (review)

* guide: don't mention Git here...
per #2908 (review)

* guide: clarify that git is needed for exps and sharing
per #2908 (review)

* guide: clarify note on Git requirement for DVC Exps
per #2908 (review)

* guide: simplify Sharing Exps intro (rel Git)
per #2908 (review)

* guide: rename exp list -r section

* copy edit

* cases: simplify note about requiring Git
per #2908 (review)

* guide: emoji for example in Sharing Exps
per #2908 (comment)

* guide: clarify note about Git-DVC repo required for Exps
per #2908 (review)

* Update content/docs/user-guide/experiment-management/sharing-experiments.md

* guide: another example emoji en Sharing Exps

* Restyled by prettier (#2972)

Co-authored-by: Restyled.io <[email protected]>

* guide: list exps in Comparing guide, linked from Sharing
per #2908 (comment)

* guide: address feedback from
#2908 (review) and below

* guide: rephrase Git history exps org
per #2908 (review)

* guide:address Exp sharing feedback from
from #2908 (review) and below

* guide: update Git remote auth limitation wording
per #2908 (comment)

* guide: more copy edits on Exp Sharing and Comparing

* guide: clarify `exp list` remote info
per #2908 (review)

* guide: un0hide exp sharing details
per #2908 (review)

* guide: move multi-exp share example to how-to
per #2908 (review)

* guide: simplify Exp Sharing intro, add diagram
per should be focusing more on explaining (in simple terms, with diagrams) how it works

* guide: fix SSH URLS link in Exp Sharing...

* exp: roll back unrelated changes

* guide: Git -> Git remote
per #2908 (review)

* guide: improve Sharing exp intro
per #2908 (review)

* exp push/pull: remove --remote and --jobs details from guide and ref descs.
rel. #2908 (comment)

* guide: remove Sharing Exps example
per #2908 (comment)

* guide: simplify Sharing Exps intro
per #2908 (review)

* guide: add exp pull to diagram in Sharing Exps
per #2908 (comment)

Co-authored-by: David de la Iglesia Castro <[email protected]>
Co-authored-by: Casper da Costa-Luis <[email protected]>
Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants